/*********************************************************************************************************************
 * CYT4BB Opensourec Library 即（ CYT4BB 开源库）是一个基于官方 SDK
 *接口的第三方开源库 Copyright (c) 2022 SEEKFREE 逐飞科技
 *
 * 本文件是 CYT4BB 开源库的一部分
 *
 * CYT4BB 开源库 是免费软件
 * 您可以根据自由软件基金会发布的 GPL（GNU General Public License，即
 *GNU通用公共许可证）的条款 即 GPL 的第3版（即
 *GPL3.0）或（您选择的）任何后来的版本，重新发布和/或修改它
 *
 * 本开源库的发布是希望它能发挥作用，但并未对其作任何的保证
 * 甚至没有隐含的适销性或适合特定用途的保证
 * 更多细节请参见 GPL
 *
 * 您应该在收到本开源库的同时收到一份 GPL 的副本
 * 如果没有，请参阅<https://www.gnu.org/licenses/>
 *
 * 额外注明：
 * 本开源库使用 GPL3.0 开源许可证协议 以上许可申明为译文版本
 * 许可申明英文版在 libraries/doc 文件夹下的 GPL3_permission_statement.txt
 *文件中 许可证副本在 libraries 文件夹下 即该文件夹下的 LICENSE 文件
 * 欢迎各位使用并传播本程序 但修改内容时必须保留逐飞科技的版权声明（即本声明）
 *
 * 文件名称          zf_device_imu963ra
 * 公司名称          成都逐飞科技有限公司
 * 版本信息          查看 libraries/doc 文件夹内 version 文件 版本说明
 * 开发环境          IAR 9.40.1
 * 适用平台          CYT4BB
 * 店铺链接          https://seekfree.taobao.com/
 *
 * 修改记录
 * 日期              作者                备注
 * 2024-01-12       pudding           first version
 ********************************************************************************************************************/
/********************************************************************************************************************
 * 接线定义：
 *                  ------------------------------------
 *                  模块管脚             单片机管脚
 *                  // 硬件 SPI 引脚
 *                  SCL/SPC            查看 zf_device_imu963ra.h 中
 *IMU963RA_SPC_PIN 宏定义 SDA/DSI            查看 zf_device_imu963ra.h 中
 *IMU963RA_SDI_PIN 宏定义 SA0/SDO            查看 zf_device_imu963ra.h 中
 *IMU963RA_SDO_PIN 宏定义 CS                 查看 zf_device_imu963ra.h 中
 *IMU963RA_CS_PIN  宏定义 VCC                3.3V电源 GND                电源地
 *                  其余引脚悬空
 *
 *                  // 软件 IIC 引脚
 *                  SCL/SPC            查看 zf_device_imu963ra.h 中
 *IMU963RA_SCL_PIN 宏定义 SDA/DSI            查看 zf_device_imu963ra.h 中
 *IMU963RA_SDA_PIN 宏定义 VCC                3.3V电源 GND                电源地
 *                  其余引脚悬空
 *                  ------------------------------------
 ********************************************************************************************************************/

#ifndef _zf_device_imu963ra_h_
#define _zf_device_imu963ra_h_

#include "zf_common_typedef.h"

//================================================定义 IMU963RA
// 基本配置================================================
#define IMU963RA_USE_SOFT_IIC (0) // 默认使用硬件 SPI 方式驱动
#if IMU963RA_USE_SOFT_IIC // 这两段 颜色正常的才是正确的 颜色灰的就是没有用的
//====================================================软件 IIC
// 驱动====================================================
#define IMU963RA_SOFT_IIC_DELAY                                                \
  (59) // 软件 IIC 的时钟延时周期 数值越小 IIC 通信速率越快
#define IMU963RA_SCL_PIN (P15_2) // 软件 IIC SCL 引脚 连接 IMU963RA 的 SCL 引脚
#define IMU963RA_SDA_PIN (P15_1) // 软件 IIC SDA 引脚 连接 IMU963RA 的 SDA 引脚
//====================================================软件 IIC
// 驱动====================================================
#else

//====================================================硬件 SPI
// 驱动====================================================
#define IMU963RA_SPI_SPEED (10 * 1000 * 1000) // 硬件 SPI 速率
#define IMU963RA_SPI (SPI_6)                  // 硬件 SPI 号
#define IMU963RA_SPC_PIN (SPI6_CLK_P03_2)     // 硬件 SPI SCK 引脚
#define IMU963RA_SDI_PIN (SPI6_MOSI_P03_1)    // 硬件 SPI MOSI 引脚
#define IMU963RA_SDO_PIN (SPI6_MISO_P3_0)     // 硬件 SPI MISO 引脚
//====================================================硬件 SPI
// 驱动====================================================
#endif

#define IMU963RA_CS_PIN (P03_3) // CS 片选引脚
#define IMU963RA_CS(x)                                                         \
  (x ? (gpio_high(IMU963RA_CS_PIN)) : (gpio_low(IMU963RA_CS_PIN)))

typedef enum {
  IMU963RA_ACC_SAMPLE_SGN_2G, // 加速度计量程 ±2G  (ACC = Accelerometer
                              // 加速度计) (SGN = signum 带符号数 表示正负范围)
                              // (G = g 重力加速度 g≈9.80 m/s^2)
  IMU963RA_ACC_SAMPLE_SGN_4G, // 加速度计量程 ±4G  (ACC = Accelerometer
                              // 加速度计) (SGN = signum 带符号数 表示正负范围)
                              // (G = g 重力加速度 g≈9.80 m/s^2)
  IMU963RA_ACC_SAMPLE_SGN_8G, // 加速度计量程 ±8G  (ACC = Accelerometer
                              // 加速度计) (SGN = signum 带符号数 表示正负范围)
                              // (G = g 重力加速度 g≈9.80 m/s^2)
  IMU963RA_ACC_SAMPLE_SGN_16G, // 加速度计量程 ±16G (ACC = Accelerometer
                               // 加速度计) (SGN = signum 带符号数 表示正负范围)
                               // (G = g 重力加速度 g≈9.80 m/s^2)
} imu963ra_acc_sample_config;

typedef enum {
  IMU963RA_GYRO_SAMPLE_SGN_125DPS, // 陀螺仪量程 ±125DPS  (GYRO = Gyroscope
                                   // 陀螺仪) (SGN = signum 带符号数
                                   // 表示正负范围) (DPS = Degree Per Second
                                   // 角速度单位 °/S)
  IMU963RA_GYRO_SAMPLE_SGN_250DPS, // 陀螺仪量程 ±250DPS  (GYRO = Gyroscope
                                   // 陀螺仪) (SGN = signum 带符号数
                                   // 表示正负范围) (DPS = Degree Per Second
                                   // 角速度单位 °/S)
  IMU963RA_GYRO_SAMPLE_SGN_500DPS, // 陀螺仪量程 ±500DPS  (GYRO = Gyroscope
                                   // 陀螺仪) (SGN = signum 带符号数
                                   // 表示正负范围) (DPS = Degree Per Second
                                   // 角速度单位 °/S)
  IMU963RA_GYRO_SAMPLE_SGN_1000DPS, // 陀螺仪量程 ±1000DPS (GYRO = Gyroscope
                                    // 陀螺仪) (SGN = signum 带符号数
                                    // 表示正负范围) (DPS = Degree Per Second
                                    // 角速度单位 °/S)
  IMU963RA_GYRO_SAMPLE_SGN_2000DPS, // 陀螺仪量程 ±2000DPS (GYRO = Gyroscope
                                    // 陀螺仪) (SGN = signum 带符号数
                                    // 表示正负范围) (DPS = Degree Per Second
                                    // 角速度单位 °/S)
  IMU963RA_GYRO_SAMPLE_SGN_4000DPS, // 陀螺仪量程 ±4000DPS (GYRO = Gyroscope
                                    // 陀螺仪) (SGN = signum 带符号数
                                    // 表示正负范围) (DPS = Degree Per Second
                                    // 角速度单位 °/S)
} imu963ra_gyro_sample_config;

typedef enum {
  IMU963RA_MAG_SAMPLE_2G, // 磁力计量程 2G (MAG = Magnetometer 磁力计) (G = Gs
                          // 高斯)
  IMU963RA_MAG_SAMPLE_8G, // 磁力计量程 8G (MAG = Magnetometer 磁力计) (G = Gs
                          // 高斯)
} imu963ra_mag_sample_config;
typedef enum { Acc, Gyro, Mag } imuFactors;

#define IMU963RA_ACC_SAMPLE_DEFAULT                                            \
  (IMU963RA_ACC_SAMPLE_SGN_8G) // 在这设置默认的 加速度计 初始化量程
#define IMU963RA_GYRO_SAMPLE_DEFAULT                                           \
  (IMU963RA_GYRO_SAMPLE_SGN_2000DPS) // 在这设置默认的 陀螺仪   初始化量程
#define IMU963RA_MAG_SAMPLE_DEFAULT                                            \
  (IMU963RA_MAG_SAMPLE_8G) // 在这设置默认的 磁力计   初始化量程
#define IMU963RA_TIMEOUT_COUNT (0x00FF) // IMU963RA 超时计数
//================================================定义 IMU963RA
// 基本配置================================================

//================================================定义 IMU963RA
// 内部地址================================================
#define IMU963RA_DEV_ADDR (0x6B) // SA0接地：0x6A SA0上拉：0x6B 模块默认上拉
#define IMU963RA_SPI_W (0x00)
#define IMU963RA_SPI_R (0x80)

#define IMU963RA_FUNC_CFG_ACCESS (0x01)
#define IMU963RA_INT1_CTRL (0x0D)
#define IMU963RA_WHO_AM_I (0x0F)
#define IMU963RA_CTRL1_XL (0x10)
#define IMU963RA_CTRL2_G (0x11)
#define IMU963RA_CTRL3_C (0x12)
#define IMU963RA_CTRL4_C (0x13)
#define IMU963RA_CTRL5_C (0x14)
#define IMU963RA_CTRL6_C (0x15)
#define IMU963RA_CTRL7_G (0x16)
#define IMU963RA_CTRL9_XL (0x18)
#define IMU963RA_OUTX_L_G (0x22)
#define IMU963RA_OUTX_L_A (0x28)

// 集线器功能相关寄存器
// 需要将FUNC_CFG_ACCESS的SHUB_REG_ACCESS位设置为1才能正确访问
#define IMU963RA_SENSOR_HUB_1 (0x02)
#define IMU963RA_MASTER_CONFIG (0x14)
#define IMU963RA_SLV0_ADD (0x15)
#define IMU963RA_SLV0_SUBADD (0x16)
#define IMU963RA_SLV0_CONFIG (0x17)
#define IMU963RA_DATAWRITE_SLV0 (0x21)
#define IMU963RA_STATUS_MASTER (0x22)

#define IMU963RA_MAG_ADDR (0x0D) // 7位IIC地址
#define IMU963RA_MAG_OUTX_L (0x00)
#define IMU963RA_MAG_CONTROL1 (0x09)
#define IMU963RA_MAG_CONTROL2 (0x0A)
#define IMU963RA_MAG_FBR (0x0B)
#define IMU963RA_MAG_CHIP_ID (0x0D)

// #define IMU963RA_ACC_SAMPLE (0x3C) // 加速度计量程
//  设置为:0x30 加速度量程为:±2G      获取到的加速度计数据
//  除以16393，可以转化为带物理单位的数据，单位：g(m/s^2) 设置为:0x38
//  加速度量程为:±4G      获取到的加速度计数据 除以8197，
//  可以转化为带物理单位的数据，单位：g(m/s^2) 设置为:0x3C 加速度量程为:±8G
//  获取到的加速度计数据 除以4098， 可以转化为带物理单位的数据，单位：g(m/s^2)
//  设置为:0x34 加速度量程为:±16G     获取到的加速度计数据 除以2049，
//  可以转化为带物理单位的数据，单位：g(m/s^2)

// #define IMU963RA_GYR_SAMPLE (0x5C) // 陀螺仪量程
//  设置为:0x52 陀螺仪量程为:±125dps  获取到的陀螺仪数据除以228.6，
//  可以转化为带物理单位的数据，单位为：°/s 设置为:0x50 陀螺仪量程为:±250dps
//  获取到的陀螺仪数据除以114.3，   可以转化为带物理单位的数据，单位为：°/s
//  设置为:0x54 陀螺仪量程为:±500dps  获取到的陀螺仪数据除以57.1，
//  可以转化为带物理单位的数据，单位为：°/s 设置为:0x58 陀螺仪量程为:±1000dps
//  获取到的陀螺仪数据除以28.6，    可以转化为带物理单位的数据，单位为：°/s
//  设置为:0x5C 陀螺仪量程为:±2000dps 获取到的陀螺仪数据除以14.3，
//  可以转化为带物理单位的数据，单位为：°/s 设置为:0x51 陀螺仪量程为:±4000dps
//  获取到的陀螺仪数据除以7.1，     可以转化为带物理单位的数据，单位为：°/s

// #define IMU963RA_MAG_SAMPLE (0x19) // 地磁计量程
//  设置为:0x19 磁力计量程为:8G     获取到的加速度计数据 除以3000，
//  可以转化为带物理单位的数据，单位：G(高斯) 设置为:0x09 磁力计量程为:2G
//  获取到的加速度计数据 除以12000，可以转化为带物理单位的数据，单位：G(高斯)
//================================================定义 IMU963RA
//  内部地址================================================

//================================================声明 IMU963RA
// 全局变量================================================
extern int16 imu963ra_acc_x, imu963ra_acc_y,
    imu963ra_acc_z; // 三轴陀螺仪数据      GYRO (陀螺仪)
extern int16 imu963ra_gyro_x, imu963ra_gyro_y,
    imu963ra_gyro_z; // 三轴加速度计数据     ACC  (accelerometer 加速度计)
extern int16 imu963ra_mag_x, imu963ra_mag_y,
    imu963ra_mag_z; // 三轴磁力计数据      MAG  (magnetometer 磁力计)
extern float imu963ra_transition_factor[3]; // 转换实际值的比例
//================================================声明 IMU963RA
// 全局变量================================================

//================================================声明 IMU963RA
// 基础函数================================================
#ifdef __cplusplus
extern "C" {
#endif                        // __cplusplus
void imu963ra_get_acc(void);  // 获取 IMU963RA 加速度计数据
void imu963ra_get_gyro(void); // 获取 IMU963RA 陀螺仪数据
void imu963ra_get_mag(void);  // 获取 IMU963RA 磁力计数据
uint8 imu963ra_init(void);    // 初始化 IMU963RA
#ifdef __cplusplus
}
#endif // __cplusplus
//================================================声明 IMU963RA
// 基础函数================================================

//================================================声明 IMU963RA
// 拓展函数================================================
//-------------------------------------------------------------------------------------------------------------------
// 函数简介     将 IMU963RA 加速度计数据转换为实际物理数据
// 参数说明     acc_value       任意轴的加速度计数据
// 返回参数     void
// 使用示例     float data = imu963ra_acc_transition(imu963ra_acc_x); // 单位为
// g(m/s^2) 备注信息
//-------------------------------------------------------------------------------------------------------------------
#define imu963ra_acc_transition(acc_value)                                     \
  ((float)acc_value / imu963ra_transition_factor[0])

//-------------------------------------------------------------------------------------------------------------------
// 函数简介     将 IMU963RA 陀螺仪数据转换为实际物理数据
// 参数说明     gyro_value      任意轴的陀螺仪数据
// 返回参数     void
// 使用示例     float data = imu963ra_gyro_transition(imu963ra_gyro_x); //
// 单位为 °/s 备注信息
//-------------------------------------------------------------------------------------------------------------------
#define imu963ra_gyro_transition(gyro_value)                                   \
  ((float)gyro_value / imu963ra_transition_factor[1])

//-------------------------------------------------------------------------------------------------------------------
// 函数简介     将 IMU963RA 磁力计数据转换为实际物理数据
// 参数说明     mag_value       任意轴的磁力计数据
// 返回参数     void
// 使用示例     float data = imu963ra_mag_transition(imu963ra_mag_x); // 单位为
// G 备注信息
//-------------------------------------------------------------------------------------------------------------------
#define imu963ra_mag_transition(mag_value)                                     \
  ((float)mag_value / imu963ra_transition_factor[2])
//================================================声明 IMU963RA
// 拓展函数================================================

#endif
